<?php
/**
 * Ruth Library
 * $Id: Abstract.php 2 2008-01-17 02:59:56Z baron314159@yahoo.com $
 *
 * LICENSE
 *
 * Copyright (c) 2007, Chris Utz
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the Impact Lab nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY CHRIS UTZ ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL CHRIS UTZ BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * @category   Ruth
 * @package    Ruth_Validate
 * @author     Chris Utz <chris@chrisutz.com>
 * @copyright  2007 Chris Utz <chris@chrisutz.com>
 * @license    http://www.opensource.org/licenses/bsd-license.php    New BSD License
 * @version    $Revision: 2 $
 */

/**
 * @see Ruth_Options
 */
require_once 'Ruth/Options.php';

/**
 * @see Ruth_Validate_Exception
 */
require_once 'Ruth/Validate/Exception.php';

/**
 * Base class for all validator classes.
 *
 * @category   Ruth
 * @package    Ruth_Validate
 * @author     Chris Utz <chris@chrisutz.com>
 * @copyright  2007 Chris Utz <chris@chrisutz.com>
 * @license    http://www.opensource.org/licenses/bsd-license.php    New BSD License
 * @version    $Revision: 2 $
 */
abstract class Ruth_Validate_Abstract
{
    /**
     * Holds the option values associated with this validator.
     *
     * @var Ruth_Options
     */
    protected $_options;

    /**
     * The name of the validator, used to refer to it when associated with
     * a Channel.
     *
     * @var string
     */
    protected $_name = null;

    /**
     * Creates a Ruth_Validate_Abstract instance, with the given options and name.
     *
     * @param null|array|string|Ruth_Options $options The options to associate with this instance
     * @param string $name Name to override the default set or extracted from the class name
     * @return void
     * @throws Ruth_Options_Exception
     */
    public function __construct($options=null, $name=null)
    {
        $nameParamValid = true;

        if ($options instanceof Ruth_Options) {
            $this->_options = $options;
        } else if (is_string($options)) {
            $this->_options = new Ruth_Options(func_get_args());
            $nameParamValid = false;
        } else {
            $this->_options = new Ruth_Options($options);
        }

        if ($name != null and $nameParamValid) {
            $this->_name = $name;
        } else if ($this->_name == null) {
            $this->_name = $this->_getNameFromClassName();
        }
    }

    /**
     * Extracts and returns the last part of the class instance's namespace
     * from its instance name.
     *
     * @return string
     * @throws Ruth_Validate_Exception
     */
    protected function _getNameFromClassName()
    {
        $numMatches = preg_match('/_([^_]+)$/', get_class($this), $matches);

        if ($numMatches > 0) {
            return $matches[1];
        } else {
            throw new Ruth_Validate_Exception("invalid validator class name format");
        }
    }

    /**
     * Setter for the validator name
     *
     * @param string $name
     */
    public function setName($name)
    {
        $this->_name = $name;
    }

    /**
     * Getter for the validator name 
     *
     * @return string
     */
    public function getName()
    {
        return $this->_name;
    }

    /**
     * Returns the options for the validator.
     *
     * @return Ruth_Options
     */
    public function getOptions()
    {
        return $this->_options;
    }

    /**
     * Determines if the value passed in is valid according to the rules and
     * options of the validator.
     *
     * @param string $value The value to check for validity.
     * @return boolean Whether or not the value is valid.
     */
    abstract public function isValid($value);
}
// vim: sw=4:ts=4:sts=4:et
